home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Sharing Fun! I Know My Savior Lives / Sunday Savers: Sharing Fun! I Know My Savior Lives.iso / mac / Xtras / Buddy API 3.7 / Buddy API Docs.swf / texts / 1288.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  3.5 KB  |  131 lines
  1. 56
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. SetDisplay 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baSetDisplay sets the screen size and depth.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baSetDisplay( Width , Height , Depth , Mode , Force )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. Integer, Integer, Integer, String, Integer. 
  36. --- RECORDSEPARATOR ---
  37. Width is the new width of the screen in pixels. 
  38. --- RECORDSEPARATOR ---
  39. Height is the new height of the screen in pixels. 
  40. --- RECORDSEPARATOR ---
  41. Depth is the new depth of the screen in bits. 
  42. --- RECORDSEPARATOR ---
  43. Mode is the way in which the new display is set. Can be: 
  44. --- RECORDSEPARATOR ---
  45. "temp" 
  46. --- RECORDSEPARATOR ---
  47. temporari
  48. --- RECORDSEPARATOR ---
  49. ly change the display settings. 
  50. --- RECORDSEPARATOR ---
  51. "perm" 
  52. --- RECORDSEPARATOR ---
  53. permanently change the display settings. 
  54. --- RECORDSEPARATOR ---
  55. "test" 
  56. --- RECORDSEPARATOR ---
  57. tests whether the display can be set without restarting. 
  58. --- RECORDSEPARATOR ---
  59. If Force is true, forces the display to change.
  60. --- RECORDSEPARATOR ---
  61.  
  62. --- RECORDSEPARATOR ---
  63. Returns:
  64. --- RECORDSEPARATOR ---
  65.  
  66. --- RECORDSEPARATOR ---
  67. Integer. 
  68. --- RECORDSEPARATOR ---
  69. Returns 0 if the display was changed or can be changed without restarting. 
  70. --- RECORDSEPARATOR ---
  71. Returns 1 if Windows will need to be restarted for the change to take effect. 
  72. --- RECORDSEPARATOR ---
  73. Returns less than 0 if another error occurred, eg invalid screen size.
  74. --- RECORDSEPARATOR ---
  75.  
  76. --- RECORDSEPARATOR ---
  77. Examples:
  78. --- RECORDSEPARATOR ---
  79.  
  80. --- RECORDSEPARATOR ---
  81. Director: 
  82. --- RECORDSEPARATOR ---
  83. set OK = baSetDisplay( 640 , 480 , 8 , "temp" , false ) 
  84. --- RECORDSEPARATOR ---
  85. Authorware: 
  86. --- RECORDSEPARATOR ---
  87. OK := baSetDisplay( 640 , 480 , 8 , "temp" , false )
  88. --- RECORDSEPARATOR ---
  89.  
  90. --- RECORDSEPARATOR ---
  91. Notes:
  92. --- RECORDSEPARATOR ---
  93.  
  94. --- RECORDSEPARATOR ---
  95. This function will not work under Windows 3.1 - it will always return 0. 
  96. --- RECORDSEPARATOR ---
  97. Not all display cards and drivers support screen changing without restarting. 
  98. --- RECORDSEPARATOR ---
  99. The force option is not officially supported by Microsoft. It forces the display to 
  100. --- RECORDSEPARATOR ---
  101. change without restarting. This may work correctly with some video cards and 
  102. --- RECORDSEPARATOR ---
  103. drivers, but can cause palette problems on others, and crash the system on some. 
  104. --- RECORDSEPARATOR ---
  105. You are advised to only use this option on known hardware and after extensive 
  106. --- RECORDSEPARATOR ---
  107. testing. 
  108. --- RECORDSEPARATOR ---
  109. If you use the "temp" mode, then the user's preferred screen display will be 
  110. --- RECORDSEPARATOR ---
  111. returned when the system is restarted. You can not set a "temp" mode unless it can 
  112. --- RECORDSEPARATOR ---
  113. be changed without restarting Windows. 
  114. --- RECORDSEPARATOR ---
  115. The "temp" mode should only be used if you do not intend the user to be able to 
  116. --- RECORDSEPARATOR ---
  117. access the task bar or desktop while your program is running. When using the 
  118. --- RECORDSEPARATOR ---
  119. "temp" mode, Windows may not position the desktop icons and task bar in usable 
  120. --- RECORDSEPARATOR ---
  121. positions.
  122. --- RECORDSEPARATOR ---
  123.  
  124. --- RECORDSEPARATOR ---
  125. See also:
  126. --- RECORDSEPARATOR ---
  127.  
  128. --- RECORDSEPARATOR ---
  129. baSetDisplayEx 
  130. --- RECORDSEPARATOR ---
  131. baScreenInfo